Skip to content

docs: add agent-friendly docs with i18n, skills, and MkDocs site - #5

Open
lassetrwa-ship-it wants to merge 4 commits into
SatoshiPortal:mainfrom
lassetrwa-ship-it:main
Open

docs: add agent-friendly docs with i18n, skills, and MkDocs site#5
lassetrwa-ship-it wants to merge 4 commits into
SatoshiPortal:mainfrom
lassetrwa-ship-it:main

Conversation

@lassetrwa-ship-it

Copy link
Copy Markdown

What

Add comprehensive documentation infrastructure for both humans and AI agents.

Changes

AI Agent Support

  • AGENTS.md: setup, build, test, architecture, gotchas — everything an agent needs
  • skills/agent-init: reusable repo onboarding skill
  • skills/frb-codegen: FRB codegen workflow with troubleshooting
  • docs/robots.txt + llms.txt: agent-aware crawl directives

Documentation Site

  • MkDocs Material with Bull Bitcoin branding (logo, Satoshi Bold)
  • +10 essentials pages: getting started, architecture, API reference, development
  • i18n: English (default), Español, Italiano, Português
  • bull_sdk/llms.txt and bull_sdk/robots.txt

Repo Fixes

  • fix_frb_generated.sh: patched sed syntax for Linux compatibility
  • .gitmodules: converted SSH → HTTPS for container/CI use
  • .gitignore: added site/, build/, .dart_tool/, .fvm/

README Update

  • AI agent callout pointing to AGENTS.md
  • Documentation site links
  • Quick start section
  • Updated project structure

Docs

https://lassetrwa-ship-it.github.io/bull_sdk/

- AGENTS.md: setup, build, test, architecture, gotchas for coding agents
- skills/agent-init: reusable repo onboarding skill
- skills/frb-codegen: FRB codegen workflow with troubleshooting
- docs/: MkDocs Material site with EN/ES/IT/PT translations
- docs/robots.txt + llms.txt: agent-aware crawl directives
- mkdocs.yml: branding with Bull Bitcoin logo, Satoshi Bold, #e30613 accent
- fix_frb_generated.sh: patched sed syntax for Linux compatibility
- .gitmodules: converted SSH URLs to HTTPS for container/CI use
- Add nav_translations for ES/IT/PT in mkdocs.yml
- Remove Material primary: red (was overriding custom CSS)
- Replace #e30613 with #cc0000 (deeper, more intense red)
- Force red header background via CSS
- Add alternate links in extra section for EN/ES/IT/PT
- Shows globe icon in header for language switching
…ructure

- Add AI agent callout pointing to AGENTS.md
- Add documentation site links (EN/ES/IT/PT)
- Add quick start section
- Update structure tree with skills/ and docs/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant